NAME¶

COPY - copy data between a file and a table

SYNOPSIS¶

COPY table_name [ ( column_name [, ...] ) ]


    FROM { 'filename' | STDIN }


    [ [ WITH ] ( option [, ...] ) ]
COPY { table_name [ ( column_name [, ...] ) ] | ( query ) }


    TO { 'filename' | STDOUT }


    [ [ WITH ] ( option [, ...] ) ]
where option can be one of:


    FORMAT format_name


    OIDS [ boolean ]


    DELIMITER 'delimiter_character'


    NULL 'null_string'


    HEADER [ boolean ]


    QUOTE 'quote_character'


    ESCAPE 'escape_character'


    FORCE_QUOTE { ( column_name [, ...] ) | * }


    FORCE_NOT_NULL ( column_name [, ...] )


    ENCODING 'encoding_name'

DESCRIPTION¶

COPY moves data between PostgreSQL tables and standard file-system files. COPY TO copies the contents of a table to a file, while COPY FROM copies data from a file to a table (appending the data to whatever is in the table already). COPY TO can also copy the results of a SELECT query.

If a list of columns is specified, COPY will only copy the data in the specified columns to or from the file. If there are any columns in the table that are not in the column list, COPY FROM will insert the default values for those columns.

COPY with a file name instructs the PostgreSQL server to directly read from or write to a file. The file must be accessible to the server and the name must be specified from the viewpoint of the server. When STDIN or STDOUT is specified, data is transmitted via the connection between the client and the server.

PARAMETERS¶

table_name

column_name

query

filename

STDIN

STDOUT

boolean

FORMAT

OIDS

DELIMITER

NULL

HEADER

QUOTE

ESCAPE

FORCE_QUOTE

FORCE_NOT_NULL

ENCODING

OUTPUTS¶

On successful completion, a COPY command returns a command tag of the form

COPY count

The count is the number of rows copied.

NOTES¶

COPY can only be used with plain tables, not with views. However, you can write COPY (SELECT * FROM viewname) TO ....

COPY only deals with the specific table named; it does not copy data to or from child tables. Thus for example COPY table TO shows the same data as SELECT * FROM ONLY table. But COPY (SELECT * FROM table) TO ... can be used to dump all of the data in an inheritance hierarchy.

You must have select privilege on the table whose values are read by COPY TO, and insert privilege on the table into which values are inserted by COPY FROM. It is sufficient to have column privileges on the column(s) listed in the command.

Files named in a COPY command are read or written directly by the server, not by the client application. Therefore, they must reside on or be accessible to the database server machine, not the client. They must be accessible to and readable or writable by the PostgreSQL user (the user ID the server runs as), not the client. COPY naming a file is only allowed to database superusers, since it allows reading or writing any file that the server has privileges to access.

Do not confuse COPY with the psql instruction opy. \copy invokes COPY FROM STDIN or COPY TO STDOUT, and then fetches/stores the data in a file accessible to the psql client. Thus, file accessibility and access rights depend on the client rather than the server when \copy is used.

It is recommended that the file name used in COPY always be specified as an absolute path. This is enforced by the server in the case of COPY TO, but for COPY FROM you do have the option of reading from a file specified by a relative path. The path will be interpreted relative to the working directory of the server process (normally the cluster's data directory), not the client's working directory.

COPY FROM will invoke any triggers and check constraints on the destination table. However, it will not invoke rules.

COPY input and output is affected by DateStyle. To ensure portability to other PostgreSQL installations that might use non-default DateStyle settings, DateStyle should be set to ISO before using COPY TO. It is also a good idea to avoid dumping data with IntervalStyle set to sql_standard, because negative interval values might be misinterpreted by a server that has a different setting for IntervalStyle.

Input data is interpreted according to ENCODING option or the current client encoding, and output data is encoded in ENCODING or the current client encoding, even if the data does not pass through the client but is read from or written to a file directly by the server.

COPY stops operation at the first error. This should not lead to problems in the event of a COPY TO, but the target table will already have received earlier rows in a COPY FROM. These rows will not be visible or accessible, but they still occupy disk space. This might amount to a considerable amount of wasted disk space if the failure happened well into a large copy operation. You might wish to invoke VACUUM to recover the wasted space.

FILE FORMATS¶

EXAMPLES¶

The following example copies a table to the client using the vertical bar (|) as the field delimiter:

COPY country TO STDOUT (DELIMITER '|');

To copy data from a file into the country table:

COPY country FROM '/usr1/proj/bray/sql/country_data';

To copy into a file just the countries whose names start with 'A':

COPY (SELECT * FROM country WHERE country_name LIKE 'A%') TO '/usr1/proj/bray/sql/a_list_countries.copy';

Here is a sample of data suitable for copying into a table from STDIN:

AF      AFGHANISTAN
AL      ALBANIA
DZ      ALGERIA
ZM      ZAMBIA
ZW      ZIMBABWE

Note that the white space on each line is actually a tab character.

The following is the same data, output in binary format. The data is shown after filtering through the Unix utility od -c. The table has three columns; the first has type char(2), the second has type text, and the third has type integer. All the rows have a null value in the third column.

0000000   P   G   C   O   P   Y  \n 377  \r  \n  \0  \0  \0  \0  \0  \0
0000020  \0  \0  \0  \0 003  \0  \0  \0 002   A   F  \0  \0  \0 013   A
0000040   F   G   H   A   N   I   S   T   A   N 377 377 377 377  \0 003
0000060  \0  \0  \0 002   A   L  \0  \0  \0 007   A   L   B   A   N   I
0000100   A 377 377 377 377  \0 003  \0  \0  \0 002   D   Z  \0  \0  \0
0000120 007   A   L   G   E   R   I   A 377 377 377 377  \0 003  \0  \0
0000140  \0 002   Z   M  \0  \0  \0 006   Z   A   M   B   I   A 377 377
0000160 377 377  \0 003  \0  \0  \0 002   Z   W  \0  \0  \0  \b   Z   I
0000200   M   B   A   B   W   E 377 377 377 377 377 377

COMPATIBILITY¶

There is no COPY statement in the SQL standard.

The following syntax was used before PostgreSQL version 9.0 and is still supported:

COPY table_name [ ( column_name [, ...] ) ]


    FROM { 'filename' | STDIN }


    [ [ WITH ]


          [ BINARY ]


          [ OIDS ]


          [ DELIMITER [ AS ] 'delimiter' ]


          [ NULL [ AS ] 'null string' ]


          [ CSV [ HEADER ]


                [ QUOTE [ AS ] 'quote' ]


                [ ESCAPE [ AS ] 'escape' ]


                [ FORCE NOT NULL column_name [, ...] ] ] ]
COPY { table_name [ ( column_name [, ...] ) ] | ( query ) }


    TO { 'filename' | STDOUT }


    [ [ WITH ]


          [ BINARY ]


          [ OIDS ]


          [ DELIMITER [ AS ] 'delimiter' ]


          [ NULL [ AS ] 'null string' ]


          [ CSV [ HEADER ]


                [ QUOTE [ AS ] 'quote' ]


                [ ESCAPE [ AS ] 'escape' ]


                [ FORCE QUOTE { column_name [, ...] | * } ] ] ]

Note that in this syntax, BINARY and CSV are treated as independent keywords, not as arguments of a FORMAT option.

The following syntax was used before PostgreSQL version 7.3 and is still supported:

COPY [ BINARY ] table_name [ WITH OIDS ]


    FROM { 'filename' | STDIN }


    [ [USING] DELIMITERS 'delimiter' ]


    [ WITH NULL AS 'null string' ]
COPY [ BINARY ] table_name [ WITH OIDS ]


    TO { 'filename' | STDOUT }


    [ [USING] DELIMITERS 'delimiter' ]


    [ WITH NULL AS 'null string' ]